Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change edit link path to main. #1607

Merged
merged 1 commit into from
Sep 11, 2020
Merged

Change edit link path to main. #1607

merged 1 commit into from
Sep 11, 2020

Conversation

rosiel
Copy link
Member

@rosiel rosiel commented Sep 4, 2020

Purpose / why

Fix #1546 - the links to edit the documentation were set to 'master' not main.

The mkdocs documentation shows it needs to be set in the mkdocs config, or it defaults to master.

What changes were made?

set 'edit_uri' which mkdocs defaulted to edit/master/docs/ to be edit/main/docs.

Verification

Do the links work?

Interested Parties

@Islandora/8-x-committers

Checklist

Pull-request reviewer should ensure the following

Person merging should ensure the following

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

@rosiel
Copy link
Member Author

rosiel commented Sep 11, 2020

ping @Islandora/8-x-committers

If someone could mkdocs build and mkdocs serve and see that the links go to the main branch, like they do when I serve it locally, that's be great.

If you haven't used mkdocs before, it's pretty simple! Ping me on slack and I'll help you set it up.

@jordandukart
Copy link
Member

Link is nice and updated. Doing a quick grep there's quite a few other instances referring to the master branch directly in the docs. Should this be handled in this issue or a separate one?

@dannylamb
Copy link
Contributor

dannylamb commented Sep 11, 2020 •
edited
Loading

I've got an open PR for that @jordandukart, feel free to merge this one.

@jordandukart
Copy link
Member

@dannylamb mentioned in Slack another pull coming for those issues so merging this.

@jordandukart jordandukart merged commit 312f4c0 into Islandora:main Sep 11, 2020
@rosiel rosiel deleted the edit-link-to-main branch September 11, 2020 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jordandukart jordandukart jordandukart approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add 'Edit this page' and 'Request documentation changes' links on every page of documentation
3 participants
@rosiel @jordandukart @dannylamb